﻿<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>PageCreater API Document </title>
    <link href="Css/API.css" rel="stylesheet" type="text/css" />
    <script language="javascript" type="text/javascript" src="Scripts/jquery-1.5.1.min.js"></script>
    <script type="text/javascript">
        var divs = "BindDataDetail,CreateIndexPageDetail,CreatePageFramDetail,CreatePageFramWithValueDetail,getUrlParaDetail"
        $(document).ready(function () {
            $("#BindDataDetail").hide();
            $("#CreateIndexPageDetail").hide();
            $("#CreatePageFramDetail").hide();
            $("#CreatePageFramWithValueDetail").hide();
            $("#getUrlParaDetail").hide();
        });
        function ShowDetail(divID) {
            var ids = divs.split(',');
            for (var i = 0; i < ids.length; i++) {
                $("#" + ids[i]).hide("fast");
            }
            $(divID).show("normal");
        }
    </script>
</head>
<body>
    <center>
        <span class="title">
            <p>
                PageCreater API Document</p>
        </span><span class="version">
            <p>
                Version:Beta 1.3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Author:Lion(刘祖民)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Blog:<a
                    href="http://www.cnblogs.com/tearsFish/">点击进入</a></p>
        </span>
    </center>
    <div class="divCore">
        <center>
            <span class="core">
                <p>
                    Core</p>
            </span>
            <center>
                <div class="divContent">
                    <a href="javascript:void(0);" onclick="ShowDetail(BindDataDetail)">BindData</a>
                </div>
                <div class="detail" id="BindDataDetail">
                    <div>
                        <p>
                            <span style="color: #309">Parameter Description:</span>
                    </div>
                    <div style="margin-left: 20px;">
                        <table>
                            <tr>
                                <td>
                                    pageIndex:
                                </td>
                                <td>
                                    显示的页码
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    pageSize:
                                </td>
                                <td>
                                    每页显示的记录条数
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    strSearchProperty:
                                </td>
                                <td>
                                    查找条件：属性名（和类字段对应，多个用逗号隔开）
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    strSearchCondition:
                                </td>
                                <td>
                                    查找条件：值（和类字段对应，多个用逗号隔开）
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    strSortProperty:
                                </td>
                                <td>
                                    排序条件：属性名（和类字段对应，多个用逗号隔开）
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    strSortCondition:
                                </td>
                                <td>
                                    查找条件：值（和类字段对应，值为："asc"或"desc"）
                                </td>
                            </tr>
                        </table>
                    </div>
                    <p>
                        <span style="color: #C06">Demonstrate:</span></p>
                    <div style="margin-left: 20px;">
                        <span style="color: #CCC">BindData(1, 10, "Name", "Lion", "Age", "asc")</span><br />
                        意思为查找Name值为Lion且按Age升序排列的数据，取前10条展示。
                    </div>
                    <p>
                        <span style="color: #CFC">Remark:</span></p>
                    <div style="margin-left: 20px;">
                        <table>
                            <tr>
                                <td>
                                    1st.
                                </td>
                                <td>
                                    页面显示记录条数请在后台构造的JSON数据中的最后一行。
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    2nd.
                                </td>
                                <td>
                                    页面必须具备ID为tabInfo和pageIndex的Div。
                                </td>
                            </tr>
                        </table>
                    </div>
                </div>
                <div class="divContent">
                    <a href="javascript:void(0);" onclick="ShowDetail(CreateIndexPageDetail)">CreateIndexPage</a>
                </div>
                <div class="detail" id="CreateIndexPageDetail">
                    <div>
                        <p>
                            <span style="color: #309">Parameter Description:</span>
                    </div>
                    <div style="margin-left: 20px;">
                        <table>
                            <tr>
                                <td>
                                    dataUrl:
                                </td>
                                <td>
                                    后台调用方法的地址
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    strColumn,:
                                </td>
                                <td>
                                    自定义列：每个列有5个参数：与数据库对应的字段名，显示的字段名，是否支持排序，生成控件类型，生成控件验证方式（用逗号隔开，前三个为必须参数，后两个为扩展参数）
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    strOpreate:
                                </td>
                                <td>
                                    自定义操作：每个操作有3个参数：操作名称，操作后台调用方法的地址，是否跳转页面（用逗号隔开）
                                </td>
                            </tr>
                        </table>
                    </div>
                    <p>
                        <span style="color: #C06">Demonstrate:</span></p>
                    <div style="margin-left: 20px;">
                        <span style="color: #CCC">var strColumn = "ID,编号,true,text,notnull,"<br />
                            + "Account,账号,false,text,notnull,"<br />
                            + "IsActive,状态,false,select|激活!true|注销!false,notnull,"<br />
                            + "Opreate,操作,false,null,null";<br />
                            var strOpreate = "修改,/User/Update,true,修改状态,/User/Withdraw,false";<br />
                            CreateIndexPage("/User/GetPaged", strColumn, strOpreate); </span>
                        <br />
                        意思为，表中得到数据的后台地址为/User/GetPaged，在生成的列表中，ID，Account,IsActive,Opreate四个字段，分别显示为编号，账号，状态，操作。<br />
                        其中包括修改和修改状态两个操作，修改操作后台调用地址为/User/Update，它将跳转到另一个页面操作；修改状态操作的后台调用地址为/User/Withdraw，它不会跳转到其他页面。
                    </div>
                    <p>
                        <span style="color: #CFC">Remark:</span></p>
                    <div style="margin-left: 20px;">
                        <table>
                            <tr>
                                <td>
                                    1st.
                                </td>
                                <td>
                                    页面显示记录条数请在后台构造的JSON数据中的最后一行。
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    2nd.
                                </td>
                                <td>
                                    页面必须具备ID为tabInfo和pageIndex的Div。
                                </td>
                            </tr>
                        </table>
                    </div>
                </div>
                <div class="divContent">
                    <a href="javascript:void(0);" onclick="ShowDetail(CreatePageFramDetail)">CreatePageFram</a>
                </div>
                <div class="detail" id="CreatePageFramDetail">
                    <div>
                        <p>
                            <span style="color: #309">Parameter Description:</span>
                    </div>
                    <div style="margin-left: 20px;">
                        <table>
                            <tr>
                                <td>
                                    str:
                                </td>
                                <td>
                                    自定控件：每个控件5个参数：与数据库对应的字段名，显示的字段名，是否支持排序，生成控件类型[若生成控件类型为Select或CheckBox之类有选项的控件，其格式为：控件类型|选项一的显示字段！选项一的值|选项二的显示字段！选项二的值...]，生成控件验证方式（用逗号隔开，前两个为扩展参数，后三个为必须参数）
                                </td>
                            </tr>
                        </table>
                    </div>
                    <p>
                        <span style="color: #C06">Demonstrate:</span></p>
                    <div style="margin-left: 20px;">
                        <span style="color: #CCC">var str = "Account,账号,false,text,notnull,"<br />
                            + "Password,密码,false,password,notnull,"<br />
                            + "IsActive,状态,false,select|激活!true|注销!false,notnull,"<br />
                            + "Opreate,操作,false,null,null";<br />
                            CreatePageFram(str);</span><br />
                        意思为当前页面会生成三个控件，第一个控件是ID,Name都为ID的文本框,显示字段为账号，<br />
                        第二个控件是ID,Name都为Password的密码框，<br />
                        第三个控件是ID,Name都为状态的下拉框，第一个选项为激活，其Value为true，第二个选项为相互消，其Value为false。
                    </div>
                    <p>
                        <span style="color: #CFC">Remark:</span></p>
                    <div style="margin-left: 20px;">
                        <table>
                            <tr>
                                <td>
                                    1st.
                                </td>
                                <td>
                                    由于本插件核心的原因，"Opreate,操作,false,null,null"是不可缺少的。
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    2nd.
                                </td>
                                <td>
                                    页面必须具备ID为divContent的Div。
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    3rd.
                                </td>
                                <td>
                                    页面可根据自己的需求进行扩展。
                                </td>
                            </tr>
                        </table>
                    </div>
                </div>
                <div class="divContent">
                    <a href="javascript:void(0);" onclick="ShowDetail(CreatePageFramWithValueDetail)">CreatePageFramWithValue</a>
                </div>
                <div class="detail" id="CreatePageFramWithValueDetail">
                    <div>
                        <p>
                            <span style="color: #309">Parameter Description:</span>
                    </div>
                    <div style="margin-left: 20px;">
                        <table>
                            <tr>
                                <td>
                                    str:
                                </td>
                                <td>
                                    自定控件：每个控件5个参数：与数据库对应的字段名，显示的字段名，是否支持排序，生成控件类型[若生成控件类型为Select或CheckBox之类有选项的控件，其格式为：控件类型|选项一的显示字段！选项一的值|选项二的显示字段！选项二的值...]，生成控件验证方式（用逗号隔开，前两个为扩展参数，后三个为必须参数）
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    Url:
                                </td>
                                <td>
                                    得到某个实体的后台方法地址
                                </td>
                            </tr>
                        </table>
                    </div>
                    <p>
                        <span style="color: #C06">Demonstrate:</span></p>
                    <div style="margin-left: 20px;">
                        <span style="color: #CCC">var str = "Account,账号,false,text,notnull,"<br />
                            + "Password,密码,false,password,notnull,"<br />
                            + "IsActive,状态,false,select|激活!true|注销!false,notnull,"<br />
                            + "Opreate,操作,false,null,null";<br />
                            CreatePageFramWithValue(str, "/User/GetUserByID");</span><br />
                        意思为当前页面会生成三个控件，第一个控件是ID,Name都为ID的文本框,显示字段为账号，<br />
                        第二个控件是ID,Name都为Password的密码框，<br />
                        第三个控件是ID,Name都为状态的下拉框，第一个选项为激活，其Value为true，第二个选项为相互消，其Value为false。 调用后台/User/GetUserByID地址返回的实体将会赋值到以上控件中。
                    </div>
                    <p>
                        <span style="color: #CFC">Remark:</span></p>
                    <div style="margin-left: 20px;">
                        <table>
                            <tr>
                                <td>
                                    1st.
                                </td>
                                <td>
                                    由于本插件核心的原因，"Opreate,操作,false,null,null"是不可缺少的。
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    2nd.
                                </td>
                                <td>
                                    页面必须具备ID为divContent的Div。
                                </td>
                            </tr>
                            <tr>
                                <td>
                                    3rd.
                                </td>
                                <td>
                                    页面可根据自己的需求进行扩展。
                                </td>
                            </tr>
                        </table>
                    </div>
                </div>
    </div>
    <div class="divTools">
        <center>
            <span class="tools">
                <p>
                    Tools</p>
            </span>
            <center>
                <p>
                    <div class="divContent">
                        <a href="javascript:void(0);" onclick="ShowDetail(getUrlParaDetail)">getUrlPara</a>
                    </div>
                    <div class="detail" id="getUrlParaDetail">
                        <div>
                            <p>
                                <span style="color: #309">Parameter Description:</span>
                        </div>
                        <div style="margin-left: 20px;">
                            Nought
                        </div>
                        <p>
                            <span style="color: #C06">Demonstrate:</span></p>
                        <div style="margin-left: 20px;">
                            <span style="color: #CCC">getUrlPara()</span><br />
                            意思为获取当前Window的location中的第一个参数（适用于MVC）
                        </div>
                        <p>
                            <span style="color: #CFC">Remark:</span></p>
                        <div style="margin-left: 20px;">
                            <table>
                                <tr>
                                    <td>
                                        1st.
                                    </td>
                                    <td>
                                        本方法只适用于MVC。
                                    </td>
                                </tr>
                            </table>
                        </div>
                    </div>
                </p>
    </div>
    <div class="divExtend">
        <center>
            <span class="extend">
                <p>
                    Extend</p>
            </span>
            <center>
                <p>
                    Nought
                </p>
    </div>
    <div class="bur">
    </div>
</body>
</html>
